﻿
// Copyright (C) 2009-2017 Luca Piccioni
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

using System;

// ReSharper disable InheritdocConsiderUsage

namespace OpenGL
{
	/// <summary>
	/// Attribute indicating whether a field shall indicate an OpenGL implementation limit.
	/// </summary>
	[AttributeUsage(AttributeTargets.Field)]
	internal class LimitAttribute : Attribute
	{
		/// <summary>
		/// Construct a LimitAttribute.
		/// </summary>
		/// <param name="enum">
		/// A <see cref="Int32"/> that specify the OpenGL enumeration value to used with Gl.Get and Gl.GetString routines.
		/// </param>
		public LimitAttribute(int @enum)
		{
			EnumValue = @enum;
		}

		/// <summary>
		/// The enumeration value representing the limit.
		/// </summary>
		public readonly int EnumValue;

		/// <summary>
		/// In the case the limit is composed by an array, this property specify the array length.
		/// </summary>
		public uint ArrayLength { get; set; }
	}
}
